<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>Ole10Native (POI API Documentation)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="Ole10Native (POI API Documentation)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Ole10Native.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/poi/poifs/filesystem/OfficeXmlFileException.html" title="class in org.apache.poi.poifs.filesystem"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10NativeException.html" title="class in org.apache.poi.poifs.filesystem"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/poifs/filesystem/Ole10Native.html" target="_top">FRAMES</a></li>
<li><a href="Ole10Native.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li><a href="#field_summary">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li><a href="#field_detail">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<p class="subTitle">org.apache.poi.poifs.filesystem</p>
<h2 title="Class Ole10Native" class="title">Class Ole10Native</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.poi.poifs.filesystem.Ole10Native</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <strong>Ole10Native</strong>
extends java.lang.Object</pre>
<div class="block">Represents an Ole10Native record which is wrapped around certain binary
 files being embedded in OLE2 documents.</div>
<dl><dt><span class="strong">Author:</span></dt>
  <dd>Rainer Schwarze</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!--   -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#ISO1">ISO1</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#OLE10_NATIVE">OLE10_NATIVE</a></strong></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#Ole10Native(byte[], int)">Ole10Native</a></strong>(byte[]&nbsp;data,
           int&nbsp;offset)</code>
<div class="block">Creates an instance and fills the fields based on the data in the given buffer.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#Ole10Native(byte[], int, boolean)">Ole10Native</a></strong>(byte[]&nbsp;data,
           int&nbsp;offset,
           boolean&nbsp;plain)</code>
<div class="block"><strong>Deprecated.</strong>&nbsp;
<div class="block"><i>parameter plain is ignored, use <a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#Ole10Native(byte[], int)"><code>Ole10Native(byte[],int)</code></a></i></div>
</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#Ole10Native(java.lang.String, java.lang.String, java.lang.String, byte[])">Ole10Native</a></strong>(java.lang.String&nbsp;label,
           java.lang.String&nbsp;filename,
           java.lang.String&nbsp;command,
           byte[]&nbsp;data)</code>
<div class="block">Creates an instance and fills the fields based on ...</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html" title="class in org.apache.poi.poifs.filesystem">Ole10Native</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#createFromEmbeddedOleObject(org.apache.poi.poifs.filesystem.DirectoryNode)">createFromEmbeddedOleObject</a></strong>(<a href="../../../../../org/apache/poi/poifs/filesystem/DirectoryNode.html" title="class in org.apache.poi.poifs.filesystem">DirectoryNode</a>&nbsp;directory)</code>
<div class="block">Creates an instance of this class from an embedded OLE Object.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html" title="class in org.apache.poi.poifs.filesystem">Ole10Native</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#createFromEmbeddedOleObject(org.apache.poi.poifs.filesystem.POIFSFileSystem)">createFromEmbeddedOleObject</a></strong>(<a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">POIFSFileSystem</a>&nbsp;poifs)</code>
<div class="block">Creates an instance of this class from an embedded OLE Object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#getCommand()">getCommand</a></strong>()</code>
<div class="block">Returns the command field - usually the name of the file being embedded
 including the full path, may be a command specified during embedding the
 file.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#getDataBuffer()">getDataBuffer</a></strong>()</code>
<div class="block">Returns the buffer containing the embedded file's data, or
 <code>null</code> if no data was embedded.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#getDataSize()">getDataSize</a></strong>()</code>
<div class="block">Returns the size of the embedded file.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#getFileName()">getFileName</a></strong>()</code>
<div class="block">Returns the fileName field - usually the name of the file being embedded
 including the full path.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#getFlags1()">getFlags1</a></strong>()</code>
<div class="block">Returns flags1 - currently unknown - usually 0x0002.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#getFlags2()">getFlags2</a></strong>()</code>
<div class="block">Returns flags2 - currently unknown - mostly 0x0000.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#getFlags3()">getFlags3</a></strong>()</code>
<div class="block">Returns the flags3 - currently unknown.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#getLabel()">getLabel</a></strong>()</code>
<div class="block">Returns the label field - usually the name of the file (without
 directory) but probably may be any name specified during
 packaging/embedding the data.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#getTotalSize()">getTotalSize</a></strong>()</code>
<div class="block">Returns the value of the totalSize field - the total length of the
 structure is totalSize + 4 (value of this field + size of this field).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#getUnknown1()">getUnknown1</a></strong>()</code>
<div class="block">Returns unknown1 field - currently unknown.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#setCommand(java.lang.String)">setCommand</a></strong>(java.lang.String&nbsp;command)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#setDataBuffer(byte[])">setDataBuffer</a></strong>(byte[]&nbsp;dataBuffer)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#setFileName(java.lang.String)">setFileName</a></strong>(java.lang.String&nbsp;fileName)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#setFlags1(short)">setFlags1</a></strong>(short&nbsp;flags1)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#setFlags2(short)">setFlags2</a></strong>(short&nbsp;flags2)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#setFlags3(short)">setFlags3</a></strong>(short&nbsp;flags3)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#setLabel(java.lang.String)">setLabel</a></strong>(java.lang.String&nbsp;label)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#setUnknown1(short)">setUnknown1</a></strong>(short&nbsp;unknown1)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#writeOut(java.io.OutputStream)">writeOut</a></strong>(java.io.OutputStream&nbsp;out)</code>
<div class="block">Have the contents printer out into an OutputStream, used when writing a
 file back out to disk (Normally, atom classes will keep their bytes
 around, but non atom classes will just request the bytes from their
 children, then chuck on their header and return)</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!--   -->
</a>
<h3>Field Detail</h3>
<a name="OLE10_NATIVE">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>OLE10_NATIVE</h4>
<pre>public static final&nbsp;java.lang.String OLE10_NATIVE</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.poifs.filesystem.Ole10Native.OLE10_NATIVE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="ISO1">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ISO1</h4>
<pre>protected static final&nbsp;java.lang.String ISO1</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.poi.poifs.filesystem.Ole10Native.ISO1">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="Ole10Native(java.lang.String, java.lang.String, java.lang.String, byte[])">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Ole10Native</h4>
<pre>public&nbsp;Ole10Native(java.lang.String&nbsp;label,
           java.lang.String&nbsp;filename,
           java.lang.String&nbsp;command,
           byte[]&nbsp;data)</pre>
<div class="block">Creates an instance and fills the fields based on ... the fields</div>
</li>
</ul>
<a name="Ole10Native(byte[], int, boolean)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>Ole10Native</h4>
<pre>public&nbsp;Ole10Native(byte[]&nbsp;data,
           int&nbsp;offset,
           boolean&nbsp;plain)
            throws <a href="../../../../../org/apache/poi/poifs/filesystem/Ole10NativeException.html" title="class in org.apache.poi.poifs.filesystem">Ole10NativeException</a></pre>
<div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>parameter plain is ignored, use <a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#Ole10Native(byte[], int)"><code>Ole10Native(byte[],int)</code></a></i></div>
<div class="block">Creates an instance and fills the fields based on the data in the given buffer.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - The buffer containing the Ole10Native record</dd><dd><code>offset</code> - The start offset of the record in the buffer</dd><dd><code>plain</code> - as of POI 3.11 this parameter is ignored</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10NativeException.html" title="class in org.apache.poi.poifs.filesystem">Ole10NativeException</a></code> - on invalid or unexcepted data format</dd></dl>
</li>
</ul>
<a name="Ole10Native(byte[], int)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Ole10Native</h4>
<pre>public&nbsp;Ole10Native(byte[]&nbsp;data,
           int&nbsp;offset)
            throws <a href="../../../../../org/apache/poi/poifs/filesystem/Ole10NativeException.html" title="class in org.apache.poi.poifs.filesystem">Ole10NativeException</a></pre>
<div class="block">Creates an instance and fills the fields based on the data in the given buffer.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - The buffer containing the Ole10Native record</dd><dd><code>offset</code> - The start offset of the record in the buffer</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10NativeException.html" title="class in org.apache.poi.poifs.filesystem">Ole10NativeException</a></code> - on invalid or unexcepted data format</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="createFromEmbeddedOleObject(org.apache.poi.poifs.filesystem.POIFSFileSystem)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createFromEmbeddedOleObject</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html" title="class in org.apache.poi.poifs.filesystem">Ole10Native</a>&nbsp;createFromEmbeddedOleObject(<a href="../../../../../org/apache/poi/poifs/filesystem/POIFSFileSystem.html" title="class in org.apache.poi.poifs.filesystem">POIFSFileSystem</a>&nbsp;poifs)
                                               throws java.io.IOException,
                                                      <a href="../../../../../org/apache/poi/poifs/filesystem/Ole10NativeException.html" title="class in org.apache.poi.poifs.filesystem">Ole10NativeException</a></pre>
<div class="block">Creates an instance of this class from an embedded OLE Object. The OLE Object is expected
 to include a stream &quot;{01}Ole10Native&quot; which contains the actual
 data relevant for this class.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>poifs</code> - POI Filesystem object</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns an instance of this class</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - on IO error</dd>
<dd><code><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10NativeException.html" title="class in org.apache.poi.poifs.filesystem">Ole10NativeException</a></code> - on invalid or unexcepted data format</dd></dl>
</li>
</ul>
<a name="createFromEmbeddedOleObject(org.apache.poi.poifs.filesystem.DirectoryNode)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createFromEmbeddedOleObject</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html" title="class in org.apache.poi.poifs.filesystem">Ole10Native</a>&nbsp;createFromEmbeddedOleObject(<a href="../../../../../org/apache/poi/poifs/filesystem/DirectoryNode.html" title="class in org.apache.poi.poifs.filesystem">DirectoryNode</a>&nbsp;directory)
                                               throws java.io.IOException,
                                                      <a href="../../../../../org/apache/poi/poifs/filesystem/Ole10NativeException.html" title="class in org.apache.poi.poifs.filesystem">Ole10NativeException</a></pre>
<div class="block">Creates an instance of this class from an embedded OLE Object. The OLE Object is expected
 to include a stream &quot;{01}Ole10Native&quot; which contains the actual
 data relevant for this class.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>directory</code> - POI Filesystem object</dd>
<dt><span class="strong">Returns:</span></dt><dd>Returns an instance of this class</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code> - on IO error</dd>
<dd><code><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10NativeException.html" title="class in org.apache.poi.poifs.filesystem">Ole10NativeException</a></code> - on invalid or unexcepted data format</dd></dl>
</li>
</ul>
<a name="getTotalSize()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTotalSize</h4>
<pre>public&nbsp;int&nbsp;getTotalSize()</pre>
<div class="block">Returns the value of the totalSize field - the total length of the
 structure is totalSize + 4 (value of this field + size of this field).</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the totalSize</dd></dl>
</li>
</ul>
<a name="getFlags1()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFlags1</h4>
<pre>public&nbsp;short&nbsp;getFlags1()</pre>
<div class="block">Returns flags1 - currently unknown - usually 0x0002.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the flags1</dd></dl>
</li>
</ul>
<a name="getLabel()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLabel</h4>
<pre>public&nbsp;java.lang.String&nbsp;getLabel()</pre>
<div class="block">Returns the label field - usually the name of the file (without
 directory) but probably may be any name specified during
 packaging/embedding the data.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the label</dd></dl>
</li>
</ul>
<a name="getFileName()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFileName</h4>
<pre>public&nbsp;java.lang.String&nbsp;getFileName()</pre>
<div class="block">Returns the fileName field - usually the name of the file being embedded
 including the full path.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the fileName</dd></dl>
</li>
</ul>
<a name="getFlags2()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFlags2</h4>
<pre>public&nbsp;short&nbsp;getFlags2()</pre>
<div class="block">Returns flags2 - currently unknown - mostly 0x0000.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the flags2</dd></dl>
</li>
</ul>
<a name="getUnknown1()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getUnknown1</h4>
<pre>public&nbsp;short&nbsp;getUnknown1()</pre>
<div class="block">Returns unknown1 field - currently unknown.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the unknown1</dd></dl>
</li>
</ul>
<a name="getCommand()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCommand</h4>
<pre>public&nbsp;java.lang.String&nbsp;getCommand()</pre>
<div class="block">Returns the command field - usually the name of the file being embedded
 including the full path, may be a command specified during embedding the
 file.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the command</dd></dl>
</li>
</ul>
<a name="getDataSize()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDataSize</h4>
<pre>public&nbsp;int&nbsp;getDataSize()</pre>
<div class="block">Returns the size of the embedded file. If the size is 0 (zero), no data
 has been embedded. To be sure, that no data has been embedded, check
 whether <a href="../../../../../org/apache/poi/poifs/filesystem/Ole10Native.html#getDataBuffer()"><code>getDataBuffer()</code></a> returns <code>null</code>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the dataSize</dd></dl>
</li>
</ul>
<a name="getDataBuffer()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDataBuffer</h4>
<pre>public&nbsp;byte[]&nbsp;getDataBuffer()</pre>
<div class="block">Returns the buffer containing the embedded file's data, or
 <code>null</code> if no data was embedded. Note that an embedding may
 provide information about the data, but the actual data is not included.
 (So label, filename etc. are available, but this method returns
 <code>null</code>.)</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the dataBuffer</dd></dl>
</li>
</ul>
<a name="getFlags3()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFlags3</h4>
<pre>public&nbsp;short&nbsp;getFlags3()</pre>
<div class="block">Returns the flags3 - currently unknown.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the flags3</dd></dl>
</li>
</ul>
<a name="writeOut(java.io.OutputStream)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeOut</h4>
<pre>public&nbsp;void&nbsp;writeOut(java.io.OutputStream&nbsp;out)
              throws java.io.IOException</pre>
<div class="block">Have the contents printer out into an OutputStream, used when writing a
 file back out to disk (Normally, atom classes will keep their bytes
 around, but non atom classes will just request the bytes from their
 children, then chuck on their header and return)</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd></dl>
</li>
</ul>
<a name="setFlags1(short)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFlags1</h4>
<pre>public&nbsp;void&nbsp;setFlags1(short&nbsp;flags1)</pre>
</li>
</ul>
<a name="setFlags2(short)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFlags2</h4>
<pre>public&nbsp;void&nbsp;setFlags2(short&nbsp;flags2)</pre>
</li>
</ul>
<a name="setFlags3(short)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFlags3</h4>
<pre>public&nbsp;void&nbsp;setFlags3(short&nbsp;flags3)</pre>
</li>
</ul>
<a name="setLabel(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLabel</h4>
<pre>public&nbsp;void&nbsp;setLabel(java.lang.String&nbsp;label)</pre>
</li>
</ul>
<a name="setFileName(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFileName</h4>
<pre>public&nbsp;void&nbsp;setFileName(java.lang.String&nbsp;fileName)</pre>
</li>
</ul>
<a name="setCommand(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setCommand</h4>
<pre>public&nbsp;void&nbsp;setCommand(java.lang.String&nbsp;command)</pre>
</li>
</ul>
<a name="setUnknown1(short)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setUnknown1</h4>
<pre>public&nbsp;void&nbsp;setUnknown1(short&nbsp;unknown1)</pre>
</li>
</ul>
<a name="setDataBuffer(byte[])">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setDataBuffer</h4>
<pre>public&nbsp;void&nbsp;setDataBuffer(byte[]&nbsp;dataBuffer)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Ole10Native.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/poi/poifs/filesystem/OfficeXmlFileException.html" title="class in org.apache.poi.poifs.filesystem"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../../../org/apache/poi/poifs/filesystem/Ole10NativeException.html" title="class in org.apache.poi.poifs.filesystem"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/poifs/filesystem/Ole10Native.html" target="_top">FRAMES</a></li>
<li><a href="Ole10Native.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li><a href="#field_summary">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li><a href="#field_detail">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>
                <i>Copyright 2014 The Apache Software Foundation or
        its licensors, as applicable.</i>
            </small></p>
</body>
</html>
